home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / pchat3b2.zip / PROCHAT.DOC < prev    next >
Text File  |  1991-12-15  |  16KB  |  304 lines
  1.       ////// //////    ///     ////  //// ////   //   //////
  2.       //  // //  //  // //   //  //  //   //   ////  / // /
  3.      //  // //  // //   // //       //   //  //  //   //
  4.     /////  /////  //   // //       ///////  //  //   //
  5.    //     // //  //   // //       //   //  //////   //
  6.   //     //  //  // //   //  //  //   //  //  //   //
  7. ////   //// //   ///     ////  //// //// //  //  ////
  8.  
  9.    by Matt Messier                   ////      ////
  10.       401-726-3859 (Data)          //  //    //  //
  11.                                       //    //  //
  12.    for use with PCBoard 14.5       ///     //  //
  13.    with support for /Xnnn           //    //  //
  14.    versions of PCBoard!        //  // // //  //
  15.                                ////  //  ////
  16.  
  17. INTRODUCTION
  18. ------------
  19.      Welcome to ProChat!  ProChat is a door program for use with PCBoard 14.5
  20. systems that enhances that chat facility between nodes.  ProChat allows any
  21. number of users to chat amongst themselves in any size groups either public
  22. or private with any number of different public or private groups.  Sound
  23. confusing?  Don't worry about it, if you think that the PCBoard CHAT/NODE
  24. command is bad, this program is for you.  It is very similar to the CompuServe
  25. type CB, however scaled down a bit for smaller systems.
  26.  
  27.      If you do not run a multi-node system, you have no use for this program.
  28. If you run a 2 or 3 line system, ProChat will work, but will have no real
  29. advantage over the built in CHAT in PCBoard.  If you have a large system with
  30. about 5 or more nodes, you will find that ProChat will be a favorite amongst
  31. your CB'ers ...
  32.  
  33. GETTING STARTED
  34. ---------------
  35.      Setting up Prochat is not difficult.  I hope I didn't scare you off with
  36. my opening statement about the program!  You should be able to have ProChat
  37. up and running in a matter of 10 or 15 minutes.  Should you wish to customize
  38. your system to make ProChat fit in a bit more smoothly, it may take a little
  39. longer than that.
  40.  
  41.     First, make ProChat it's own little directory.  You'll find that it's
  42. easiest to do it this way.  All of your nodes can share the files (including
  43. the configuration files), so there is no need to make multiple files for each
  44. node on your system.  Place all of the files in the distribution ZIP file into
  45. this directory.
  46.  
  47.     The next thing you'll want to do is run the setup program.  The setup
  48. program is outlined in greater detail later in this document.  For now, let's
  49. just say run the program and configure everything.  Ok, great.  Everything is
  50. configured and we're ready to make batch files.
  51.  
  52.     Make your batch file to run ProChat.  ProChat uses the standard ProKit
  53. command line parameters and batch file.  For those of you unfamiliar with
  54. ProKit based doors, here is an example of what your batch file should look
  55. like:
  56.  
  57. @echo off
  58. cd\prochat
  59. prochat prochat.cnf c:\pcb1
  60. cd\pcb1
  61. if exist event.bat event
  62. node1                   <- command to reload your board
  63.  
  64.     Last, but not least, modify your doors.lst file to reflect the addition
  65. of your new door.  You'll probably want to set it up to SHELL (in which case
  66. you would not put the last two lines of the above example in your batch file)
  67. to make everything run smoothly.  I call my batch file CB so my callers can
  68. just type CB at the main menu and drop right into ProChat.  Don't forget to
  69. add the new door to your doors menu and let your users know it's there!
  70.  
  71.     To go a step further, you may wish to modify your PCBTEXT file(s).  ProChat
  72. allows users to page others in PCBoard.  In order to do this, some changes are
  73. needed for your PCBTEXT file to let users know they are being paged to go into
  74. ProChat and not the built in CHAT facility inside PCBoard.  Below is a list of
  75. record numbers you may wish to modify and what you may want to change them to.
  76.  
  77. 225: " wants you in ProChat, @FIRST@."
  78. 226: "To respond, at the main Command line enter CB."
  79. 227: "Node CHAT: (U)navailable, (Enter)=no change?"
  80. 228: "Node CHAT: (A)vailable, (Enter)=no change?"
  81. 311: "CHATTING in ProChat"
  82.  
  83.      There are other records relating to Node CHAT as well, but those are the
  84. ones that'll make the most difference.
  85.  
  86. THE SETUP PROGRAM
  87. -----------------
  88.      The setup program is fairly easy to use and is pretty much self-
  89. explanitory.  This section will outline the use of the program to the point
  90. where if you have any questions you have had too much to drink.  <BIG GRIN>
  91.  
  92.      There are basically four different types of fields that can be modified.
  93. They are strings, numbers, toggles, and lists.
  94.  
  95.      When editing strings, the field is automatically formatted to uppercase,
  96. lowercase, mixed, or none for you.  Use the right and left arrow keys to move
  97. around the field, backspace and delete to remove text, home to go to the
  98. beginning of the field, and end to go to the end.  Pressing ctrl-end will
  99. delete from the cursor to the end of the field.  If you press ctrl-left or
  100. ctrl-right, the cursor will move one word to the left or to the right.
  101.  
  102.      When editing numbers, use the right and left arrow keys to move around
  103. the field, backspace and delete to delete, home to go to the beginning of the
  104. field, and end to go to the end.  Pressing ctrl-end will delete from the
  105. cursor to the end of the field.  If you enter a value that is out of range, you
  106. will not be able to move to another field until a valid value is entered.
  107.  
  108.      When editing toggles, pressing the space bar will toggle from yes to no
  109. and vice-versa.  If you press 'y', it will switch to yes, and if you press 'n',
  110. it will switch to no.
  111.  
  112.      When editing lists, there are a couple of stages.  The first stage is when
  113. you first move to the field.  Pressing the space bar or enter will cause a
  114. window with a list in it to pop up.  This is stage two.  Use the up and down
  115. arrow keys to move through the list and press enter to choose the item you want
  116. to set the field to.  If you press ESC here, any changes to this field will be
  117. aborted.  If you pressed enter to pop up the window, when a selection is made,
  118. you will be moved onto the next field, otherwise you will be back at stage one.
  119.  
  120.      When you are editing any one of the four types of fields, you always have
  121. the option of exiting the programming (and saving any changes made) by pressing
  122. the ESC key.  If you press tab, enter, or the down arrow, you will be moved on
  123. to the next field.  If you press shift-tab or the up arrow, you will be moved
  124. back to the previous field.
  125.  
  126. SETUP: FILE INFORMATION
  127. -----------------------
  128. PCBoard node information file: This is the path and name of your usernet.dat
  129. data file.  Without this information, Prochat could not display node scans or
  130. page users within chat.
  131.  
  132. ProChat node information file: This is the path and name of your prochat.dat
  133. data file.  This file contains information for the users currently in prochat
  134. including their name, handle, channel, squelch value, etc.  This file is
  135. automatically created and maintained by ProChat.
  136.  
  137. Chat data file: This is the path and name of your chat.dat data file.  This
  138. file is used for exchanging messages back and forth between the various nodes
  139. on the system.  If node 1 sends a message out it is written to this file and
  140. read in by the other nodes.  This file is created and maintained by ProChat.
  141. The only time you should have to intervene is if the file starts getting too
  142. big (which it will, trust me!)  When you delete it, try to make sure there is
  143. no one inside ProChat at the time.  Should you delete it while users are in
  144. ProChat, the program should recover so it's not a big problem.
  145.  
  146. ProChat channel data file: This is the path and name of your channels.dat data
  147. file.  This file is used to keep track of how many users are chatting on each
  148. channel, squelch value, and whatnot.  This file is also created and maintained
  149. by ProChat.
  150.  
  151. Bad Handle Trashcan file: This is the path and name of your trashcan data file.
  152. If there are certain names or words that you do not want users to use in their
  153. handles, this is where you should put them.  Whenever a user selects a handle,
  154. it is checked against this file to make sure that it is valid.  In this file,
  155. there are two types of entries that you can have.  The first is just a line
  156. with the name you do not want used.  The second has an asterisk in the first
  157. column of the line.  This will cause ProChat to not allow users to use a
  158. certain word in any part of their handle.  For instance, if you put "*SYSOP"
  159. in your trashcan, users would not be able to be tricky and use " SYSOP" as
  160. their handle an impersonate you.
  161.  
  162. Caller Help Display file: This is the path and name of the text file to display
  163. to callers when they ask for help.  Two defaults are supplied with ProChat.
  164. One is a rather lengthy text file explaining each command individually and what
  165. it does.  The other is a brief list of all of the commands available.
  166.  
  167. ProChat Entrance display file: This is the path and name of the text file to
  168. display to callers when they first enter ProChat.  This is the same thing as
  169. PCBoard's GCTOPIC file.
  170.  
  171. SETUP: REGISTRATION INFORMATION
  172. -------------------------------
  173.      If you have not registered ProChat yet, there is no need to modify
  174. anything in this section.  When you register ProChat, you give me the name of
  175. your system as you would like it to appear and I give you a number.  You put
  176. both of those items in this section and you'll be ready to roll.
  177.  
  178. SETUP: MISCELLANEOUS INFORMATION
  179. --------------------------------
  180. Driver Type: This is the only item require by the ProKit interface itself.
  181. It is the type of async driver you wish to use.  You may use with INTERRUPT
  182. or BIOS.  INTERRUPT is the preferred method, but if it doesn't work on your
  183. system, try BIOS.  If BIOS doesn't work then give me a call and I'll see what
  184. I can do.
  185.  
  186. Use fast message check method: When this is enabled, ProChat will only check
  187. for incoming messages when the input line is blank and when the enter key is
  188. pressed.  If this is disabled, ProChat will constantly check for incoming
  189. messages every 5 seconds.  This is intended for those slower systems where
  190. the typing becomes slow and choppy.
  191.  
  192. PCBoard version: Here is where you put the version of PCBoard you are running.
  193. This doesn't mean "14.5a/E9", it just means the "/E9" part.  So in other words,
  194. if you were running the /E25 version of the code, you would be "/E25" in this
  195. field.  There is one special exception to this field.  If you are running the
  196. /U version of PCBoard, you should place "/U99" in this field.  This field is
  197. required to determine how many nodes are online, and also if you are using the
  198. extended USERNET.DAT version or the old version.  Only the "/Xnnn" versions of
  199. PCBoard use the extended USERNET.DAT file for the time being.
  200.  
  201. Allow paging in PCBoard: If you do not want users to bother other users in
  202. PCBoard, set this flag to no.  If you would like users to be able to receive
  203. chat requests while in PCBoard, set it to yes.
  204.  
  205. Number of channels: This setting determines the size of your channels.dat file.
  206. It also places a restriction on how many channels users have to choose from on
  207. the system.  For most systems, a value of 10 is reasonable, but you may have up
  208. to 1000 channels, in which case you would need 2000 nodes to have 2 people
  209. chatting on each channel.
  210.  
  211. Allow paging in ProChat: If you do not want users to be able to page other
  212. users in ProChat, set this flag to no.  If you would like users to be able to
  213. receive chat requests in proChat, set it to yes.
  214.  
  215. Default channel: When a user enters ProChat you may wish to place the user in
  216. some channel other than channel 1.  You may place the user in any channel you
  217. want, just be careful not to put the user in a channel about the limit on the
  218. number of channels you set above.
  219.  
  220. Show private messages to sysop: If you want to be able to see the private /SE
  221. messages going back and forth between users while you are in ProChat, set this
  222. flag to yes.  If you don't want to be bothered with them, set it to no.  Even 
  223. if this flag is set to no, users will still be able to send private messages
  224. back and forth.
  225.  
  226. Default squelch: Much like default channel, you may place users in any squelch
  227. setting you like when they first enter chat.  Leaving this blank will place
  228. users in public chat.
  229.  
  230. Display city in node scan: When a node scan command is issued, you may wish to
  231. exclude user's calling locations from the list.  If you do, set this flag to
  232. no, otherwise set it to yes.
  233.  
  234. Time Warning Frequency: When this is set to a non-zero value, ProChat will
  235. notify the user of how much time is left every x minutes, where x is the value
  236. set in this field.  Setting this to zero (0) will disable this feature.
  237.  
  238. Allow use of handles: If you don't want users to use handles while in chat, set
  239. this to no.  When handles are not allowed, the user's first name is used in
  240. place of a handle.  If set to yes, the user will be asked for a handle when he
  241. first enters ProChat with his first name as the default handle.
  242.  
  243. Allow duplicate handles: Allowing duplicate handles can become confusing.  For
  244. instance, if two users were chatting, both with the handle "Matt", it would be
  245. impossible to tell which Matt was saying what.  But, for those of you that like
  246. adventure, you may set this to yes and allow users to use the same handles.
  247.  
  248. DATA FILES
  249. ----------
  250.      ProChat creates and maintains three data files.  They are the node
  251. information data file, chat data file, and channel data file.  When the chat
  252. data file becomes too big, it may be deleted and it will start over again with
  253. no problems.  I do not recommend deleting this file while users are in ProChat,
  254. but it shouldn't cause any major problems.  The other two files should require
  255. no intervention.  The only time you should mess around with them is in the 
  256. event of a power failure while people are in ProChat or whatever.  If this
  257. should happen and a user is stuck in the file when they really aren't in
  258. ProChat, just delete both the channels.dat and the prochat.dat files.  Do not
  259. delete either file if there is someone in ProChat.
  260.  
  261. REGISTRATION
  262. ------------
  263.      ProChat is not free software.  It is distributed under the policy of
  264. shareware - try before you buy sort of thing.  If you like ProChat and you use
  265. it on a continuous basis, please register it.  Many long hours of time and
  266. effort have gone into the development of this program.  It wasn't as easy as it
  267. may seem.
  268.  
  269.      Should you make the wise decision to register prochat, there is a $25 base
  270. registration fee.  If you run 6 nodes or more, add $5 for each node.  So in
  271. other words, if you run 10 nodes, your registration fee would be $25 + 5 * $5,
  272. or $50.  If you are registering from Canada, please add an extra $5 for bank
  273. processing fees (I really hate those, they get me for $5 every time).  Please
  274. make all checks or money orders payable to Matt Messier.
  275.  
  276.      When you send your registration fee in, make sure you give me the
  277. following information:
  278.  
  279. 1) Your name
  280. 2) Your BBS name as you would like it to appear in ProChat
  281. 3) Your voice telephone number
  282. 4) Your BBS telephone number(s)
  283.  
  284. After I receive your registration information, I will be calling your system
  285. to give you your registration information.
  286.  
  287. Send your bundle o' joy to the following address:
  288.  
  289. ProChat Registration
  290. c/o Matt Messier
  291. 3 Loring Drive
  292. Lincoln, RI
  293. 02865-1623
  294.  
  295. Thank you for your support!
  296.  
  297. SUPPORT
  298. -------
  299.      I run a 2-node 24 hour bulletin board.  I only have one incoming line at
  300. the moment which is 401-726-3859.  There is a ProChat Support conference set
  301. up for questions, suggestions, comments, and whatever niceties you can think
  302. of.  The latest version of ProChat can always be found in file directories 5,
  303. 12, and 16 as a free/no time download.
  304.